home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / etc / wpa_supplicant / functions.sh < prev    next >
Encoding:
Linux/UNIX/POSIX Shell Script  |  2009-04-08  |  27.6 KB  |  1,081 lines
  1. #!/bin/sh
  2.  
  3. #####################################################################
  4. ## Purpose
  5. # This file contains common shell functions used by scripts of the
  6. # wpasupplicant package to allow ifupdown to manage wpa_supplicant.
  7. # It also contains some functions used by wpa_action(8) that allow
  8. # ifupdown to be managed by wpa_cli(8) action events.
  9. #
  10. # This file is provided by the wpasupplicant package.
  11.  
  12. #####################################################################
  13. # Copyright (C) 2006 - 2008 Debian/Ubuntu wpasupplicant Maintainers 
  14. # <pkg-wpa-devel@lists.alioth.debian.org>
  15. #
  16. # This program is free software; you can redistribute it and/or
  17. # modify it under the terms of the GNU General Public License
  18. # as published by the Free Software Foundation; either version 2
  19. # of the License, or (at your option) any later version.
  20. #
  21. # This program is distributed in the hope that it will be useful,
  22. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  23. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24. # GNU General Public License for more details.
  25. #
  26. # On Debian GNU/Linux systems, the text of the GPL license can be
  27. # found in /usr/share/common-licenses/GPL.
  28.  
  29. #####################################################################
  30. ## global variables
  31. # wpa_supplicant variables
  32. WPA_SUP_BIN="/sbin/wpa_supplicant"
  33. WPA_SUP_PNAME="wpa_supplicant"
  34. WPA_SUP_PIDFILE="/var/run/wpa_supplicant.${WPA_IFACE}.pid"
  35. #WPA_SUP_LOGFILE="/var/log/wpa_supplicant.${WPA_IFACE}.log"
  36. WPA_SUP_LOGFILE="syslog"
  37.  
  38. # wpa_cli variables
  39. WPA_CLI_BIN="/sbin/wpa_cli"
  40. WPA_CLI_PNAME="wpa_cli"
  41. WPA_CLI_PIDFILE="/var/run/wpa_action.${WPA_IFACE}.pid"
  42. WPA_CLI_LOGFILE="/var/log/wpa_action.${WPA_IFACE}.log"
  43. WPA_CLI_TIMESTAMP="/var/run/wpa_action.${WPA_IFACE}.timestamp"
  44. WPA_CLI_IFUPDOWN="/var/run/wpa_action.${WPA_IFACE}.ifupdown"
  45.  
  46. # sendsigs omission interface, present in initscripts (>= 2.86.ds1-48)
  47. if [ -d /lib/init/rw/sendsigs.omit.d/ ]; then
  48.     # Debian
  49.     WPA_SUP_OMIT_PIDFILE="/lib/init/rw/sendsigs.omit.d/wpasupplicant.wpa_supplicant.${WPA_IFACE}.pid"
  50.     WPA_CLI_OMIT_PIDFILE="/lib/init/rw/sendsigs.omit.d/wpasupplicant.wpa_action.${WPA_IFACE}.pid"
  51. elif [ -d /var/run/sendsigs.omit.d/ ]; then
  52.     # Ubuntu, see https://launchpad.net/bugs/181541 for status
  53.     WPA_SUP_OMIT_PIDFILE="/var/run/sendsigs.omit.d/wpasupplicant.wpa_supplicant.${WPA_IFACE}.pid"
  54.     WPA_CLI_OMIT_PIDFILE="/var/run/sendsigs.omit.d/wpasupplicant.wpa_action.${WPA_IFACE}.pid"
  55. else
  56.     WPA_SUP_OMIT_PIDFILE=
  57.     WPA_CLI_OMIT_PIDFILE=
  58. fi
  59.  
  60. # default ctrl_interface socket directory
  61. if [ -z "$WPA_CTRL_DIR" ]; then
  62.     WPA_CTRL_DIR="/var/run/wpa_supplicant"
  63. fi
  64.  
  65. # verbosity variables
  66. if [ -n "$IF_WPA_VERBOSITY" ] || [ "$VERBOSITY" = "1" ]; then
  67.     TO_NULL="/dev/stdout"
  68.     DAEMON_VERBOSITY="--verbose"
  69. else
  70.     TO_NULL="/dev/null"
  71.     DAEMON_VERBOSITY="--quiet"
  72. fi
  73.  
  74. #####################################################################
  75. ## wpa_cli wrapper
  76. # Path to common ctrl_interface socket and iface supplied.
  77. # NB: WPA_CTRL_DIR cannot be used for interactive commands, it is
  78. # set only in the environment that wpa_cli provides when processing
  79. # action events.
  80. #
  81. wpa_cli () {
  82.     "$WPA_CLI_BIN" -p "$WPA_CTRL_DIR" -i "$WPA_IFACE" "$@"
  83.  
  84.     return "$?"
  85. }
  86.  
  87. #####################################################################
  88. ## verbose and stderr message wrapper
  89. # Ensures a standard and easily identifiable message is printed by
  90. # scripts using this function library.
  91. #
  92. # verbose    To stdout when IF_WPA_VERBOSITY or VERBOSITY is true
  93. #
  94. # action    Same as verbose but without newline
  95. #        Useful for allowing wpa_cli commands to echo result
  96. #        value of 'OK' or 'FAILED'
  97. #
  98. # stderr    Echo warning or error messages to stderr
  99. #
  100. # NB: when called by wpa_action, there is no redirection (verbose)
  101. #
  102. wpa_msg () {
  103.     if [ -n "$WPA_ACTION" ]; then
  104.         shift
  105.         echo "wpa_action: $@"
  106.         return
  107.     fi
  108.     
  109.     case "$1" in 
  110.         "verbose")
  111.             shift
  112.             echo "$WPA_SUP_PNAME: $@" >$TO_NULL
  113.             ;;
  114.         "action")
  115.             shift
  116.             echo -n "$WPA_SUP_PNAME: $@ -- " >$TO_NULL
  117.             ;;
  118.         "stderr")
  119.             shift
  120.             echo "$WPA_SUP_PNAME: $@" >/dev/stderr
  121.             ;;
  122.         *)
  123.             ;;
  124.     esac
  125. }
  126.  
  127. #####################################################################
  128. ## validate daemon pid files
  129. # Test daemon process ID files via start-stop-daemon with a signal 0
  130. # given the exec binary and pidfile location.
  131. #
  132. # $1    daemon
  133. # $2    pidfile
  134. #
  135. # Returns true when pidfile exists, the process ID exists _and_ was
  136. # created by the exec binary.
  137. #
  138. # If the test fails, but the pidfile exists, it is stale
  139. #
  140. test_daemon_pidfile () {
  141.     local DAEMON
  142.     local PIDFILE
  143.     
  144.     if [ -n "$1" ]; then
  145.         DAEMON="$1"
  146.     fi
  147.     
  148.     if [ -f "$2" ]; then
  149.         PIDFILE="$2"
  150.     fi
  151.     
  152.     if [ -n "$DAEMON" ] && [ -f "$PIDFILE" ]; then
  153.         if start-stop-daemon --stop --quiet --signal 0 \
  154.             --exec "$DAEMON" --pidfile "$PIDFILE"; then
  155.             return 0
  156.         else
  157.             rm -f "$PIDFILE"
  158.             return 1
  159.         fi
  160.     else
  161.         return 1
  162.     fi
  163. }
  164.  
  165. # validate wpa_supplicant pidfile
  166. test_wpa_supplicant () {
  167.     test_daemon_pidfile "$WPA_SUP_BIN" "$WPA_SUP_PIDFILE"
  168. }
  169.  
  170. # validate wpa_cli pidfile
  171. test_wpa_cli () {
  172.     test_daemon_pidfile "$WPA_CLI_BIN" "$WPA_CLI_PIDFILE"
  173. }
  174.  
  175. #####################################################################
  176. ## daemonize wpa_supplicant
  177. # Start wpa_supplicant via start-stop-dameon with all required
  178. # options. Will start if environment variable WPA_SUP_CONF is present
  179. #
  180. # Required options:
  181. # -B    dameonize/background process
  182. # -D    driver backend ('wext' if none given)
  183. # -P    process ID file
  184. # -C    path to ctrl_interface socket directory
  185. #
  186. # Optional options:
  187. # -c    configuration file
  188. # -W    wait for wpa_cli to attach to ctrl_interface socket
  189. # -b    bridge interface name
  190. # -f    path to log file
  191. #
  192. init_wpa_supplicant () {
  193.     [ -n "$WPA_SUP_CONF" ] || return 0
  194.  
  195.     local WPA_SUP_OPTIONS
  196.  
  197.     if [ -n "$WPA_ACTION_SCRIPT" ]; then
  198.         if [ -x "$WPA_ACTION_SCRIPT" ]; then
  199.             WPA_SUP_OPTIONS="-W -B -P $WPA_SUP_PIDFILE -i $WPA_IFACE"
  200.             wpa_msg verbose "wait for wpa_cli to attach"
  201.         else
  202.             wpa_msg stderr "action script \"$WPA_ACTION_SCRIPT\" not executable"
  203.             return 1
  204.         fi
  205.     else
  206.         WPA_SUP_OPTIONS="-B -P $WPA_SUP_PIDFILE -i $WPA_IFACE"
  207.     fi
  208.  
  209.     if [ -n "$IF_WPA_BRIDGE" ]; then
  210.         WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -b $IF_WPA_BRIDGE"
  211.         wpa_msg verbose "wpa-bridge $IF_WPA_BRIDGE"
  212.     fi
  213.  
  214.     if [ -n "$IF_WPA_DRIVER" ]; then
  215.         wpa_msg verbose "wpa-driver $IF_WPA_DRIVER"
  216.         case "$IF_WPA_DRIVER" in
  217.             hostap|ipw|madwifi|ndiswrapper)
  218.                 WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -D wext"
  219.                 wpa_msg stderr "\"$IF_WPA_DRIVER\" wpa-driver is unsupported"
  220.                 wpa_msg stderr "using \"wext\" wpa-driver instead ..."
  221.                 ;;
  222.             *)
  223.                 WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -D $IF_WPA_DRIVER"
  224.                 ;;
  225.         esac
  226.     else
  227.         WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -D wext"
  228.         wpa_msg verbose "using default driver type: wpa-driver wext"
  229.     fi
  230.  
  231.     if [ -n "$IF_WPA_DEBUG_LEVEL" ]; then
  232.         case "$IF_WPA_DEBUG_LEVEL" in
  233.             3)
  234.                 WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -t -ddd"
  235.                 ;;
  236.             2)
  237.                 WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -t -dd"
  238.                 ;;
  239.             1)
  240.                 WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -t -d"
  241.                 ;;
  242.             0)
  243.                 # wpa_supplicant default verbosity
  244.                 ;;
  245.             -1)
  246.                 WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -q"
  247.                 ;;
  248.             -2)
  249.                 WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -qq"
  250.                 ;;
  251.         esac
  252.         wpa_msg verbose "using debug level: $IF_WPA_DEBUG_LEVEL"
  253.     else
  254.         # log warnings only by default
  255.         WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -q"
  256.     fi
  257.  
  258.     if [ -n "$IF_WPA_LOGFILE" ]; then
  259.         # custom log file
  260.         WPA_SUP_LOGFILE="$IF_WPA_LOGFILE"
  261.         wpa_msg verbose "logging to $IF_WPA_LOGFILE"
  262.     fi
  263.  
  264.     if [ "$WPA_SUP_LOGFILE" = syslog ]; then
  265.         WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -s"
  266.     elif [ -d "${WPA_SUP_LOGFILE%/*}" ]; then
  267.         WPA_SUP_OPTIONS="$WPA_SUP_OPTIONS -f $WPA_SUP_LOGFILE"
  268.     else
  269.         wpa_msg stderr "unable to log output to $WPA_SUP_LOGFILE"
  270.     fi
  271.  
  272.     wpa_msg verbose "$WPA_SUP_BIN $WPA_SUP_OPTIONS $WPA_SUP_CONF"
  273.         
  274.     start-stop-daemon --start --oknodo $DAEMON_VERBOSITY \
  275.         --name $WPA_SUP_PNAME --startas $WPA_SUP_BIN --pidfile $WPA_SUP_PIDFILE \
  276.         -- $WPA_SUP_OPTIONS $WPA_SUP_CONF
  277.  
  278.     if [ "$?" -ne 0 ]; then
  279.         wpa_msg stderr "$WPA_SUP_BIN daemon failed to start"
  280.         return 1
  281.     fi
  282.  
  283.     if [ -n "$WPA_SUP_OMIT_PIDFILE" ]; then
  284.         local WPA_PIDFILE_WAIT
  285.         local MAX_WPA_PIDFILE_WAIT
  286.         WPA_PIDFILE_WAIT="0"
  287.         MAX_WPA_PIDFILE_WAIT="5"
  288.         until [ -s "$WPA_SUP_PIDFILE" ]; do
  289.             if [ "$WPA_PIDFILE_WAIT" -ge "$MAX_WPA_PIDFILE_WAIT" ]; then
  290.                 wpa_msg stderr "timed out waiting for creation of $WPA_SUP_PIDFILE"
  291.                 return 1
  292.             else
  293.                 wpa_msg verbose "waiting for \"$WPA_SUP_PIDFILE\": " \
  294.                     "$WPA_PIDFILE_WAIT (max. $MAX_WPA_PIDFILE_WAIT)"
  295.             fi
  296.  
  297.             WPA_PIDFILE_WAIT=$(($WPA_PIDFILE_WAIT + 1))
  298.             sleep 1
  299.         done
  300.         wpa_msg verbose "creating sendsigs omission pidfile: $WPA_SUP_OMIT_PIDFILE"
  301.         cat "$WPA_SUP_PIDFILE" > "$WPA_SUP_OMIT_PIDFILE"
  302.     else
  303.         wpa_msg verbose "sendsigs omission pidfile not created"
  304.     fi
  305.  
  306.     local WPA_SOCKET_WAIT
  307.     local MAX_WPA_SOCKET_WAIT
  308.     WPA_SOCKET_WAIT="0"
  309.     MAX_WPA_SOCKET_WAIT="5"
  310.     until [ -S "$WPA_CTRL_DIR/$WPA_IFACE" ]; do
  311.         if [ "$WPA_SOCKET_WAIT" -ge "$MAX_WPA_SOCKET_WAIT" ]; then
  312.             wpa_msg stderr "ctrl_interface socket not found at $WPA_CTRL_DIR/$WPA_IFACE"
  313.             return 1
  314.         else
  315.             wpa_msg verbose "waiting for \"$WPA_CTRL_DIR/$WPA_IFACE\": " \
  316.                 "$WPA_SOCKET_WAIT (max. $MAX_WPA_SOCKET_WAIT)"
  317.         fi
  318.         
  319.         WPA_SOCKET_WAIT=$(($WPA_SOCKET_WAIT + 1))
  320.         sleep 1
  321.     done
  322.     
  323.     wpa_msg verbose "ctrl_interface socket located at $WPA_CTRL_DIR/$WPA_IFACE"
  324. }
  325.  
  326. #####################################################################
  327. ## stop wpa_supplicant process
  328. # Kill wpa_supplicant via start-stop-daemon, given the location of
  329. # the pidfile or ctrl_interface socket path and interface name
  330. #
  331. kill_wpa_supplicant () {
  332.     test_wpa_supplicant || return 0
  333.  
  334.     wpa_msg verbose "terminating $WPA_SUP_PNAME daemon via pidfile $WPA_SUP_PIDFILE"
  335.  
  336.     start-stop-daemon --stop --oknodo $DAEMON_VERBOSITY \
  337.         --exec $WPA_SUP_BIN --pidfile $WPA_SUP_PIDFILE
  338.  
  339.     if [ -f "$WPA_SUP_PIDFILE" ]; then
  340.         rm -f "$WPA_SUP_PIDFILE"
  341.     fi
  342.  
  343.     if [ -f "$WPA_SUP_OMIT_PIDFILE" ]; then
  344.         wpa_msg verbose "removing $WPA_SUP_OMIT_PIDFILE"
  345.         rm -f "$WPA_SUP_OMIT_PIDFILE"
  346.     fi
  347. }
  348.  
  349. #####################################################################
  350. ## reload wpa_supplicant process
  351. # Sending a HUP signal causes wpa_supplicant to reparse its
  352. # configuration file
  353. #
  354. reload_wpa_supplicant () {
  355.     if test_wpa_supplicant; then
  356.         wpa_msg verbose "reloading wpa_supplicant configuration file via HUP signal"
  357.         start-stop-daemon --stop --signal HUP \
  358.             --name "$WPA_SUP_PNAME" --pidfile "$WPA_SUP_PIDFILE"
  359.     else
  360.         wpa_msg verbose "cannot $WPA_ACTION, $WPA_SUP_PIDFILE does not exist"
  361.     fi
  362. }
  363.  
  364. #####################################################################
  365. ## daemonize wpa_cli and action script
  366. # If environment variable WPA_ACTION_SCRIPT is present, wpa_cli will
  367. # be spawned via start-stop-daemon
  368. #
  369. # Required options:
  370. # -a    action script => wpa_action
  371. # -P    process ID file
  372. # -B    background process
  373. #
  374. init_wpa_cli () {
  375.     [ -n "$WPA_ACTION_SCRIPT" ] || return 0
  376.  
  377.     local WPA_CLI_OPTIONS
  378.     WPA_CLI_OPTIONS="-B -P $WPA_CLI_PIDFILE -i $WPA_IFACE"
  379.  
  380.     wpa_msg verbose "$WPA_CLI_BIN $WPA_CLI_OPTIONS -p $WPA_CTRL_DIR -a $WPA_ACTION_SCRIPT"
  381.         
  382.     start-stop-daemon --start --oknodo $DAEMON_VERBOSITY \
  383.         --name $WPA_CLI_PNAME --startas $WPA_CLI_BIN --pidfile $WPA_CLI_PIDFILE \
  384.         -- $WPA_CLI_OPTIONS -p $WPA_CTRL_DIR -a $WPA_ACTION_SCRIPT
  385.  
  386.     if [ "$?" -ne 0 ]; then
  387.         wpa_msg stderr "$WPA_CLI_BIN daemon failed to start"
  388.         return 1
  389.     fi
  390.  
  391.     if [ -n "$WPA_CLI_OMIT_PIDFILE" ]; then
  392.         local WPA_PIDFILE_WAIT
  393.         local MAX_WPA_PIDFILE_WAIT
  394.         WPA_PIDFILE_WAIT="0"
  395.         MAX_WPA_PIDFILE_WAIT="5"
  396.         until [ -s "$WPA_CLI_PIDFILE" ]; do
  397.             if [ "$WPA_PIDFILE_WAIT" -ge "$MAX_WPA_PIDFILE_WAIT" ]; then
  398.                 wpa_msg stderr "timed out waiting for creation of $WPA_CLI_PIDFILE"
  399.                 return 1
  400.             else
  401.                 wpa_msg verbose "waiting for \"$WPA_CLI_PIDFILE\": " \
  402.                     "$WPA_PIDFILE_WAIT (max. $MAX_WPA_PIDFILE_WAIT)"
  403.             fi
  404.  
  405.             WPA_PIDFILE_WAIT=$(($WPA_PIDFILE_WAIT + 1))
  406.             sleep 1
  407.         done
  408.         wpa_msg verbose "creating sendsigs omission pidfile: $WPA_CLI_OMIT_PIDFILE"
  409.         cat "$WPA_CLI_PIDFILE" > "$WPA_CLI_OMIT_PIDFILE"
  410.     else
  411.         wpa_msg verbose "sendsigs omission pidfile not created"
  412.     fi
  413. }
  414.  
  415. #####################################################################
  416. ## stop wpa_cli process
  417. # Kill wpa_cli via start-stop-daemon, given the location of the
  418. # pidfile
  419. #
  420. kill_wpa_cli () {
  421.     test_wpa_cli || return 0
  422.     
  423.     wpa_msg verbose "terminating $WPA_CLI_PNAME daemon via pidfile $WPA_CLI_PIDFILE"
  424.     
  425.     start-stop-daemon --stop --oknodo $DAEMON_VERBOSITY \
  426.         --exec $WPA_CLI_BIN --pidfile $WPA_CLI_PIDFILE
  427.     
  428.     if [ -f "$WPA_CLI_PIDFILE" ]; then
  429.         rm -f "$WPA_CLI_PIDFILE"
  430.     fi
  431.  
  432.     if [ -f "$WPA_CLI_OMIT_PIDFILE" ]; then
  433.         rm -f "$WPA_CLI_OMIT_PIDFILE"
  434.     fi
  435.  
  436.     if [ -f "$WPA_CLI_TIMESTAMP" ]; then
  437.         rm -f "$WPA_CLI_TIMESTAMP"
  438.     fi
  439.  
  440.     if [ -L "$WPA_CLI_IFUPDOWN" ]; then
  441.         rm -f "$WPA_CLI_IFUPDOWN"
  442.     fi
  443. }
  444.  
  445. #####################################################################
  446. ## higher level wpa_cli wrapper for variable and set_network commands
  447. # wpa_cli_do <value> <type> <variable> [set_network variable] <desc>
  448. #
  449. # $1    envorinment variable
  450. # $2    data type of variable {raw|ascii}
  451. # $3    wpa_cli variable, if $3 is set_network, shift and take 
  452. #    set_network subvariable
  453. # $4    wpa-* string as it would appear in interfaces file, enhances
  454. #    verbose messages
  455. #
  456. wpa_cli_do () {
  457.     if [ -z "$1" ]; then
  458.         return 0
  459.     fi
  460.     
  461.     local WPACLISET_VALUE
  462.     local WPACLISET_VARIABLE
  463.     local WPACLISET_DESC
  464.     
  465.     case "$2" in
  466.         ascii)
  467.             # Double quote
  468.             WPACLISET_VALUE="\"$1\""
  469.             ;;
  470.         raw|*)
  471.             # Provide raw value
  472.             WPACLISET_VALUE="$1"
  473.             ;;
  474.     esac
  475.     
  476.     case "$3" in
  477.         set_network)
  478.             if [ -z "$WPA_ID" ]; then
  479.                 return 1
  480.             fi
  481.             shift
  482.             WPACLISET_VARIABLE="set_network $WPA_ID $3"
  483.             ;;
  484.         *)
  485.             WPACLISET_VARIABLE="$3"
  486.             ;;
  487.     esac
  488.     
  489.     case "$4" in
  490.         *-psk|*-passphrase|*-passwd*|*-wep-key*)
  491.             WPACLISET_DESC="$4 *****"
  492.             ;;
  493.         *)
  494.             WPACLISET_DESC="$4 $WPACLISET_VALUE"
  495.             ;;
  496.     esac
  497.  
  498.     wpa_msg action "$WPACLISET_DESC"
  499.     
  500.     wpa_cli $WPACLISET_VARIABLE "$WPACLISET_VALUE" >$TO_NULL
  501.  
  502.     if [ "$?" -ne 0 ]; then
  503.         wpa_msg stderr "$WPACLISET_DESC failed!"
  504.     fi
  505. }
  506.  
  507. #####################################################################
  508. ## check value data type in plaintext or hex
  509. # returns 0 if input consists of hexadecimal digits only, 1 otherwise
  510. #
  511. ishex () {
  512.     if [ -z "$1" ]; then 
  513.         return 0
  514.     fi
  515.     
  516.     case "$1" in
  517.         *[!0-9a-fA-F]*)
  518.             # plaintext
  519.             return 1
  520.             ;;
  521.         *)
  522.             # hexadecimal
  523.             return 0
  524.             ;;
  525.     esac
  526. }
  527.  
  528. #####################################################################
  529. ## sanity check and set psk|passphrase
  530. # Warn about strange psk|passphrase values
  531. #
  532. # $1    psk or passphrase value
  533. # 
  534. # If psk is surrounded by quotes strip them.
  535. #
  536. # If psk contains all hexadecimal characters and string length is 64:
  537. #    is 256bit hexadecimal
  538. # else:
  539. #     is plaintext
  540. #
  541. # plaintext passphrases must be 8 - 63 characters in length
  542. # 256-bit hexadecimal key must be 64 characters in length
  543. #
  544. wpa_key_check_and_set () {
  545.     if [ "$#" -ne 3 ]; then
  546.         return 0
  547.     fi
  548.  
  549.     local KEY
  550.     local KEY_LEN
  551.     local KEY_TYPE
  552.     local ENC_TYPE
  553.     
  554.     case "$1" in
  555.         '"'*'"')
  556.             # Strip surrounding quotation marks
  557.             KEY=$(echo -n "$1" | sed 's/^"//;s/"$//')
  558.             ;;
  559.         *)
  560.             KEY="$1"
  561.             ;;
  562.     esac
  563.  
  564.     KEY_LEN="${#KEY}"
  565.  
  566.     case "$2" in
  567.         wep_key*)
  568.             ENC_TYPE="WEP"
  569.             ;;
  570.         psk)
  571.             ENC_TYPE="WPA"
  572.             ;;
  573.         *)
  574.             return 0
  575.             ;;
  576.     esac
  577.  
  578.     if [ "$ENC_TYPE" = "WEP" ]; then
  579.         if ishex "$KEY"; then
  580.             case "$KEY_LEN" in
  581.                 10|26|32|58)
  582.                     # 64/128/152/256-bit WEP
  583.                     KEY_TYPE="raw"
  584.                     ;;
  585.                 *)
  586.                     KEY_TYPE="ascii"
  587.                     ;;
  588.             esac
  589.         else
  590.             KEY_TYPE="ascii"
  591.         fi
  592.  
  593.         if [ "$KEY_TYPE" = "ascii" ]; then
  594.             if [ "$KEY_LEN" -lt "5" ]; then
  595.                 wpa_msg stderr "WARNING: plaintext or ascii WEP key has $KEY_LEN characters,"
  596.                 wpa_msg stderr "it must have at least 5 to be valid."
  597.             fi
  598.         fi
  599.     elif [ "$ENC_TYPE" = "WPA" ]; then
  600.         if ishex "$KEY"; then
  601.             case "$KEY_LEN" in
  602.                 64)
  603.                     # 256-bit WPA
  604.                     KEY_TYPE="raw"
  605.                     ;;
  606.                 *)
  607.                     KEY_TYPE="ascii"
  608.                     ;;
  609.             esac
  610.         else
  611.             KEY_TYPE="ascii"
  612.         fi
  613.  
  614.         if [ "$KEY_TYPE" = "ascii" ]; then
  615.             if [ "$KEY_LEN" -lt "8" ] || [ "$KEY_LEN" -gt "63" ]; then
  616.                 wpa_msg stderr "WARNING: plaintext or ascii WPA key has $KEY_LEN characters,"
  617.                 wpa_msg stderr "it must have between 8 and 63 to be valid."
  618.                 wpa_msg stderr "If the WPA key is a 256-bit hexadecimal key, it must have"
  619.                 wpa_msg stderr "exactly 64 characters."
  620.             fi
  621.         fi
  622.     fi
  623.  
  624.     wpa_cli_do "$KEY" "$KEY_TYPE" set_network "$2" "$3"
  625. }
  626.  
  627. #####################################################################
  628. ## formulate a usable configuration from interfaces(5) wpa- lines
  629. # A series of wpa_cli commands corresponding to environment variables
  630. # created as a result of wpa- lines in an interfaces stanza.
  631. #
  632. # NB: no-act when roaming daemon is used (to avoid prematurely
  633. # attaching to ctrl_interface socket)
  634. #
  635. conf_wpa_supplicant () {
  636.     if [ -n "$WPA_ACTION_SCRIPT" ]; then
  637.         return 0
  638.     fi
  639.  
  640.     if [ "$IF_WPA_DRIVER" = "wired" ]; then
  641.         IF_WPA_AP_SCAN="0"
  642.         wpa_msg verbose "forcing ap_scan=0 (required for wired IEEE8021X auth)"
  643.     fi
  644.  
  645.     if [ -n "$IF_WPA_ESSID" ]; then
  646.         # #403316, be similar to wireless tools
  647.         IF_WPA_SSID="$IF_WPA_ESSID"
  648.     fi
  649.     
  650.     wpa_cli_do "$IF_WPA_AP_SCAN" raw \
  651.         ap_scan wpa-ap-scan
  652.     
  653.     wpa_cli_do "$IF_WPA_PREAUTHENTICATE" raw \
  654.         preauthenticate wpa-preauthenticate
  655.         
  656.     if [ -n "$IF_WPA_SSID" ] || [ "$IF_WPA_DRIVER" = "wired" ] || \
  657.         [ -n "$IF_WPA_KEY_MGMT" ]; then
  658.         
  659.         case "$IF_WPA_SSID" in
  660.             '"'*'"')
  661.                 IF_WPA_SSID=$(echo -n "$IF_WPA_SSID" | sed 's/^"//;s/"$//')
  662.                 ;;
  663.             *)
  664.                 ;;
  665.         esac
  666.         
  667.         WPA_ID=$(wpa_cli add_network)
  668.  
  669.         wpa_msg verbose "configuring network block -- $WPA_ID"
  670.         
  671.         wpa_cli_do "$IF_WPA_SSID" ascii \
  672.             set_network ssid wpa-ssid
  673.         
  674.         wpa_cli_do "$IF_WPA_PRIORITY" raw \
  675.             set_network priority wpa-priority
  676.         
  677.         wpa_cli_do "$IF_WPA_BSSID" raw \
  678.             set_network bssid wpa-bssid
  679.         
  680.         if [ -s "$IF_WPA_PSK_FILE" ]; then
  681.             IF_WPA_PSK=$(cat "$IF_WPA_PSK_FILE")
  682.         fi
  683.         
  684.         # remain compat with wpa-passphrase-file
  685.         if [ -s "$IF_WPA_PASSPHRASE_FILE" ]; then
  686.             IF_WPA_PSK=$(cat "$IF_WPA_PASSPHRASE_FILE")
  687.         fi
  688.         
  689.         # remain compat with wpa-passphrase
  690.         if [ -n "$IF_WPA_PASSPHRASE" ]; then
  691.             IF_WPA_PSK="$IF_WPA_PASSPHRASE"
  692.         fi
  693.     
  694.         if [ -n "$IF_WPA_PSK" ]; then
  695.             wpa_key_check_and_set "$IF_WPA_PSK" \
  696.                 psk wpa-psk
  697.         fi
  698.         
  699.         wpa_cli_do "$IF_WPA_PAIRWISE" raw \
  700.             set_network pairwise wpa-pairwise
  701.         
  702.         wpa_cli_do "$IF_WPA_GROUP" raw \
  703.             set_network group wpa-group
  704.  
  705.         wpa_cli_do "$IF_WPA_MODE" raw \
  706.             set_network mode wpa-mode
  707.  
  708.         wpa_cli_do "$IF_WPA_FREQUENCY" raw \
  709.             set_network frequency wpa-frequency
  710.         
  711.         wpa_cli_do "$IF_WPA_KEY_MGMT" raw \
  712.             set_network key_mgmt wpa-key-mgmt
  713.         
  714.         wpa_cli_do "$IF_WPA_PROTO" raw \
  715.             set_network proto wpa-proto
  716.         
  717.         wpa_cli_do "$IF_WPA_AUTH_ALG" raw \
  718.             set_network auth_alg wpa-auth-alg
  719.         
  720.         wpa_cli_do "$IF_WPA_SCAN_SSID" raw \
  721.             set_network scan_ssid wpa-scan-ssid
  722.         
  723.         wpa_cli_do "$IF_WPA_IDENTITY" ascii \
  724.             set_network identity wpa-identity
  725.         
  726.         wpa_cli_do "$IF_WPA_ANONYMOUS_IDENTITY" ascii \
  727.             set_network anonymous_identity wpa-anonymous-identity
  728.         
  729.         wpa_cli_do "$IF_WPA_EAP" raw \
  730.             set_network eap wpa-eap
  731.         
  732.         wpa_cli_do "$IF_WPA_EAPPSK" raw \
  733.             set_network eappsk wpa-eappsk
  734.  
  735.         wpa_cli_do "$IF_WPA_NAI" ascii \
  736.             set_network nai wpa-nai
  737.  
  738.         wpa_cli_do "$IF_WPA_PASSWORD" ascii \
  739.             set_network password wpa-password
  740.  
  741.         wpa_cli_do "$IF_WPA_CA_CERT" ascii \
  742.             set_network ca_cert wpa-ca-cert
  743.  
  744.         wpa_cli_do "$IF_WPA_CA_PATH" ascii \
  745.             set_network ca_path wpa-ca-path
  746.  
  747.         wpa_cli_do "$IF_WPA_CLIENT_CERT" ascii \
  748.             set_network client_cert wpa-client-cert
  749.  
  750.         wpa_cli_do "$IF_WPA_PRIVATE_KEY" ascii \
  751.             set_network private_key wpa-private-key
  752.  
  753.         wpa_cli_do "$IF_WPA_PRIVATE_KEY_PASSWD" ascii \
  754.             set_network private_key_passwd wpa-private-key-passwd
  755.         
  756.         wpa_cli_do "$IF_WPA_DH_FILE" ascii \
  757.             set_network dh_file wpa-dh-file
  758.  
  759.         wpa_cli_do "$IF_WPA_SUBJECT_MATCH" ascii \
  760.             set_network subject_match wpa-subject-match
  761.  
  762.         wpa_cli_do "$IF_WPA_ALTSUBJECT_MATCH" ascii \
  763.             set_network altsubject_match wpa-altsubject-match
  764.  
  765.         wpa_cli_do "$IF_WPA_CA_CERT2" ascii \
  766.             set_network ca_cert2 wpa-ca-cert2
  767.  
  768.         wpa_cli_do "$IF_WPA_CA_PATH2" ascii \
  769.             set_network ca_path2 wpa-ca-path2
  770.  
  771.         wpa_cli_do "$IF_WPA_CLIENT_CERT2" ascii \
  772.             set_network client_cert2 wpa-client-cert2
  773.  
  774.         wpa_cli_do "$IF_WPA_PRIVATE_KEY2" ascii \
  775.             set_network private_key2 wpa-private-key2
  776.  
  777.         wpa_cli_do "$IF_WPA_PRIVATE_KEY_PASSWD2" ascii \
  778.             set_network private_key_passwd2 wpa-private-key-passwd2
  779.         
  780.         wpa_cli_do "$IF_WPA_DH_FILE2" ascii \
  781.             set_network dh_file2 wpa-dh-file2
  782.  
  783.         wpa_cli_do "$IF_WPA_SUBJECT_MATCH2" ascii \
  784.             set_network subject_match2 wpa-subject-match2
  785.  
  786.         wpa_cli_do "$IF_WPA_ALTSUBJECT_MATCH2" ascii \
  787.             set_network altsubject_match2 wpa-altsubject-match2
  788.         
  789.         wpa_cli_do "$IF_WPA_EAP_METHODS" raw \
  790.             set_network eap_methods wpa-eap-methods
  791.  
  792.         wpa_cli_do "$IF_WPA_PHASE1" ascii \
  793.             set_network phase1 wpa-phase1
  794.  
  795.         wpa_cli_do "$IF_WPA_PHASE2" ascii \
  796.             set_network phase2 wpa-phase2
  797.  
  798.         wpa_cli_do "$IF_WPA_PCSC" raw \
  799.             set_network pcsc wpa-pcsc
  800.  
  801.         wpa_cli_do "$IF_WPA_PIN" ascii \
  802.             set_network pin wpa-pin
  803.  
  804.         wpa_cli_do "$IF_WPA_ENGINE" raw \
  805.             set_network engine wpa-engine
  806.  
  807.         wpa_cli_do "$IF_WPA_ENGINE_ID" ascii \
  808.             set_network engine_id wpa-engine-id
  809.  
  810.         wpa_cli_do "$IF_WPA_KEY_ID" ascii \
  811.             set_network key_id wpa-key-id
  812.  
  813.         wpa_cli_do "$IF_WPA_EAPOL_FLAGS" raw \
  814.             set_network eapol_flags wpa-eapol-flags
  815.         
  816.         if [ -n "$IF_WPA_WEP_KEY0" ]; then
  817.             wpa_key_check_and_set "$IF_WPA_WEP_KEY0" \
  818.                 wep_key0 wpa-wep-key0
  819.         fi
  820.         
  821.         if [ -n "$IF_WPA_WEP_KEY1" ]; then
  822.             wpa_key_check_and_set "$IF_WPA_WEP_KEY1" \
  823.                 wep_key1 wpa-wep-key1
  824.         fi
  825.  
  826.         if [ -n "$IF_WPA_WEP_KEY2" ]; then
  827.             wpa_key_check_and_set "$IF_WPA_WEP_KEY2" \
  828.                 wep_key2 wpa-wep-key2
  829.         fi
  830.  
  831.         if [ -n "$IF_WPA_WEP_KEY3" ]; then
  832.             wpa_key_check_and_set "$IF_WPA_WEP_KEY3" \
  833.                 wep_key3 wpa-wep-key3
  834.         fi
  835.         
  836.         wpa_cli_do "$IF_WPA_WEP_TX_KEYIDX" raw \
  837.             set_network wep_tx_keyidx wpa-wep-tx-keyidx
  838.         
  839.         wpa_cli_do "$IF_WPA_PROACTIVE_KEY_CACHING" raw \
  840.             set_network proactive_key_caching wpa-proactive-key-caching
  841.             
  842.         wpa_cli_do "$IF_WPA_PAC_FILE" ascii \
  843.             set_network pac_file wpa-pac-file
  844.         
  845.         wpa_cli_do "$IF_WPA_MODE" raw \
  846.             set_network mode wpa-mode
  847.         
  848.         wpa_cli_do "$IF_WPA_PEERKEY" raw \
  849.             set_network peerkey wpa-peerkey
  850.             
  851.         wpa_cli_do "$IF_FRAGMENT_SIZE" raw \
  852.             set_network fragment_size wpa-fragment-size
  853.  
  854.         wpa_cli_do "$IF_WPA_ID_STR" ascii \
  855.             set_network id_str wpa-id-str
  856.         
  857.         wpa_cli_do "$WPA_ID" raw \
  858.             enable_network "enabling network block"
  859.     fi
  860. }
  861.  
  862. #####################################################################
  863. ## wpa_action basic logging
  864. # Log actions to file
  865. #
  866. wpa_log_init () {
  867.     [ -w "$WPA_CLI_LOGFILE" ] || return 0
  868.  
  869.     exec >> "$WPA_CLI_LOGFILE" 2>&1
  870. }
  871.  
  872. # log timestamp and wpa_action arguments
  873. wpa_log_action () {
  874.     [ -w "$WPA_CLI_LOGFILE" ] || return 0
  875.  
  876.     local DATE
  877.     
  878.     DATE=$(date +"%H:%M:%S  %Y-%m-%d")
  879.     echo "########## $DATE ##########"
  880.     echo "IFACE=$WPA_IFACE ACTION=$WPA_ACTION"
  881. }
  882.  
  883. # log wpa_cli environment variables
  884. wpa_log_environment () {
  885.     [ -w "$WPA_CLI_LOGFILE" ] || return 0
  886.  
  887.     echo "WPA_ID=$WPA_ID WPA_ID_STR=$WPA_ID_STR"
  888.     echo "WPA_CTRL_DIR=$WPA_CTRL_DIR"
  889. }
  890.  
  891. #####################################################################
  892. ## hysteresis checking
  893. # Networking tools such as dhcp clients used with ifupdown can
  894. # synthesize artificial ACTION events, particuarly just after a
  895. # DISCONNECTED/CONNECTED events are experienced in quick succession.
  896. # This can lead to infinite event loops, and in extreme cases has the
  897. # potential to cause system instability.
  898. #
  899. wpa_hysteresis_event () {
  900.     local TIME
  901.  
  902.     TIME=$(date +%s)
  903.     echo "$TIME" > "$WPA_CLI_TIMESTAMP"
  904. }
  905.  
  906. wpa_hysteresis_check () {
  907.     if [ -f "$WPA_CLI_TIMESTAMP" ]; then
  908.         local TIME
  909.         local TIMESTAMP
  910.         local TIMEWAIT
  911.         TIME=$(date +%s)
  912.         # current time minus 4 second event buffer
  913.         TIMEWAIT=$(($TIME-4))
  914.         # get time of last event
  915.         TIMESTAMP=$(cat $WPA_CLI_TIMESTAMP)
  916.         # compare values, allowing new action to be processed 
  917.         # only if last action was more than 4 seconds ago
  918.         if [ "$TIMEWAIT" -le "$TIMESTAMP" ]; then
  919.             echo "Ignoring $WPA_ACTION event, too soon after previous event"
  920.             return 1
  921.         fi
  922.     fi
  923.  
  924.     return 0
  925. }
  926.  
  927. #####################################################################
  928. ## identify ifupdown files
  929. # Identify ifupdown core files, so that state of the interface can be
  930. # checked. This is the weakest part of the wpa_action roaming scheme,
  931. # it would be _much_ better if stateless ifupdown capabilities were
  932. # a reality.
  933. #
  934. ifupdown_check () {
  935.     if [ -e /etc/network/interfaces ]; then
  936.         INTERFACES_FILE="/etc/network/interfaces"
  937.     else
  938.         echo "Cannot locate ifupdown's \"interfaces\" file, $WPA_IFACE will not be configured"
  939.         return 1
  940.     fi
  941.  
  942.     if [ -e /etc/network/run/ifstate ]; then
  943.         # debian's ifupdown
  944.         IFSTATE_FILE="/etc/network/run/ifstate"
  945.     elif [ -e /var/run/network/ifstate ]; then
  946.         # ubuntu's
  947.         IFSTATE_FILE="/var/run/network/ifstate"
  948.     else
  949.         echo "Cannot locate ifupdown's \"ifstate\" file, $WPA_IFACE will not be configured"
  950.         return 1
  951.     fi
  952.  
  953.     return 0
  954. }
  955.  
  956. ifupdown_status () {
  957.     if grep -s -q "^${WPA_IFACE}=${WPA_LOGICAL_IFACE}" "$IFSTATE_FILE"; then
  958.         return 0
  959.     fi
  960.  
  961.     echo "Interface \"$WPA_IFACE\" failed to establish a connection."
  962.     echo "Attempting reassociation..."
  963.     return 1
  964. }
  965.  
  966. ifupdown_lock () {
  967.     ln -s lock "$WPA_CLI_IFUPDOWN"
  968. }
  969.  
  970. ifupdown_locked () {
  971.     [ -L "$WPA_CLI_IFUPDOWN" ] && return 0
  972.  
  973.     return 1
  974. }
  975.  
  976. ifupdown_unlock () {
  977.     rm -f "$WPA_CLI_IFUPDOWN"
  978. }
  979.  
  980. #####################################################################
  981. ## apply mapping logic and ifup logical interface
  982. # Apply mapping logic via id_str or external mapping script, check
  983. # state of IFACE with respect to ifupdown and ifup logical interaface
  984. #
  985. ifup () {
  986.     local WPA_LOGICAL_IFACE
  987.     
  988.     if [ -z "$IF_WPA_MAPPING_SCRIPT_PRIORITY" ] && [ -n "$WPA_ID_STR" ]; then
  989.         WPA_LOGICAL_IFACE="$WPA_ID_STR"
  990.         echo "Mapping logical interface via id_str: $WPA_LOGICAL_IFACE"
  991.     fi
  992.     
  993.     if [ -z "$WPA_LOGICAL_IFACE" ] && [ -n "$IF_WPA_MAPPING_SCRIPT" ]; then
  994.         echo "Mapping logical interface via wpa-mapping-script: $IF_WPA_MAPPING_SCRIPT"
  995.         
  996.         local WPA_MAP_STDIN
  997.         
  998.         WPA_MAP_STDIN=$(set | sed -n 's/^\(IF_WPA_MAP[0-9]*\)=.*/echo \$\1/p')
  999.         
  1000.         if [ -n "$WPA_MAP_STDIN" ]; then
  1001.             WPA_LOGICAL_IFACE=$(eval "$WPA_MAP_STDIN" | "$IF_WPA_MAPPING_SCRIPT" "$WPA_IFACE")
  1002.         else        
  1003.             WPA_LOGICAL_IFACE=$("$IF_WPA_MAPPING_SCRIPT" "$WPA_IFACE")
  1004.         fi
  1005.         
  1006.         if [ -n "$WPA_LOGICAL_IFACE" ]; then
  1007.             echo "Mapping script result: $WPA_LOGICAL_IFACE"
  1008.         else
  1009.             echo "Mapping script failed."
  1010.         fi
  1011.     fi
  1012.  
  1013.     if [ -z "$WPA_LOGICAL_IFACE" ]; then
  1014.         if [ -n "$IF_WPA_ROAM_DEFAULT_IFACE" ]; then
  1015.             WPA_LOGICAL_IFACE="$IF_WPA_ROAM_DEFAULT_IFACE"
  1016.             echo "Using wpa-roam-default-iface: $WPA_LOGICAL_IFACE"
  1017.         else
  1018.             WPA_LOGICAL_IFACE="default"
  1019.             echo "Using fallback logical interface: $WPA_LOGICAL_IFACE"
  1020.         fi
  1021.     fi
  1022.  
  1023.     if [ -n "$WPA_LOGICAL_IFACE" ]; then
  1024.         if egrep -q "^iface[[:space:]]+${WPA_LOGICAL_IFACE}[[:space:]]+inet" "$INTERFACES_FILE"; then
  1025.             : # logical network is defined
  1026.         else
  1027.             echo "No network defined for \"$WPA_LOGICAL_IFACE\" in \"$INTERFACES_FILE\""
  1028.             echo "Trying to configure the \"default\" network instead ..."
  1029.             WPA_LOGICAL_IFACE="default"
  1030.         fi
  1031.             
  1032.         echo "ifup $WPA_IFACE=$WPA_LOGICAL_IFACE"
  1033.  
  1034.         ifupdown_lock
  1035.         
  1036.         if grep -q "^$WPA_IFACE=$WPA_IFACE" "$IFSTATE_FILE"; then
  1037.             # Force settings over the unconfigured "master" IFACE
  1038.             /sbin/ifup -v --force "$WPA_IFACE=$WPA_LOGICAL_IFACE"
  1039.         else
  1040.             /sbin/ifup -v "$WPA_IFACE=$WPA_LOGICAL_IFACE"
  1041.         fi
  1042.  
  1043.         ifupdown_unlock
  1044.     else
  1045.         echo "No suitable logical interface mapping for ifupdown to configure"
  1046.     fi
  1047. }
  1048.  
  1049. #####################################################################
  1050. ## ifdown IFACE
  1051. # Check IFACE state and ifdown as requested.
  1052. #
  1053. ifdown () {
  1054.     if grep -q "^$WPA_IFACE" "$IFSTATE_FILE"; then
  1055.         ifupdown_lock
  1056.  
  1057.         echo "ifdown $WPA_IFACE"
  1058.         /sbin/ifdown -v "$WPA_IFACE"
  1059.  
  1060.         ifupdown_unlock
  1061.     else
  1062.         echo "Ignoring request to take \"$WPA_IFACE\" down, it is not up"
  1063.     fi
  1064. }
  1065.  
  1066. #####################################################################
  1067. ## keep IFACE scanning
  1068. # After ifdown, the IFACE may be left "down", and inhibits 
  1069. # wpa_supplicant's ability to continue roaming.
  1070. #
  1071. # NB: use iproute if present, flushing the IFACE first
  1072. #
  1073. if_post_down_up () {
  1074.     if type ip >/dev/null; then
  1075.         ip addr flush dev "$WPA_IFACE" 2>/dev/null
  1076.         ip link set "$WPA_IFACE" up
  1077.     else
  1078.         ifconfig "$WPA_IFACE" up
  1079.     fi
  1080. }
  1081.